Platform Explorer / Nuxeo Platform 2023.21

Operation TemplateProcessor.Render (Render with template)

In component org.nuxeo.platform.TemplateSources.operations

Description

Render the target document with the associated template if any. Returns the rendered Blob or the main Blob if no template is associated to the document.
Operation id TemplateProcessor.Render
Category Conversion
Label Render with template
Requires
Since

Parameters

Name Description Type Required Default value
attach boolean no  
save boolean no true 
serializer string no  
store boolean no false 
templateData string no  
templateName string no  

Signature

Inputs document
Outputs blob

Implementation Information

Implementation Class Class: org.nuxeo.template.automation.RenderWithTemplateOperation
Contributing Component org.nuxeo.platform.TemplateSources.operations

JSON Definition

{
  "id" : "TemplateProcessor.Render",
  "label" : "Render with template",
  "category" : "Conversion",
  "requires" : null,
  "description" : "Render the target document with the associated template if any. Returns the rendered Blob or the main Blob if no template is associated to the document.",
  "url" : "TemplateProcessor.Render",
  "signature" : [ "document", "blob" ],
  "params" : [ {
    "name" : "attach",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  }, {
    "name" : "serializer",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "store",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "false" ]
  }, {
    "name" : "templateData",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "templateName",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}